<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/pico/critical_section.h File Reference</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.0.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('critical__section_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">critical_section.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="lock__core_8h_source.html">pico/lock_core.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for critical_section.h:</div>
<div class="dyncontent">
<div class="center"><img src="critical__section_8h__incl.png" border="0" usemap="#ainclude_2pico_2critical__section_8h" alt=""/></div>
<map name="ainclude_2pico_2critical__section_8h" id="ainclude_2pico_2critical__section_8h">
<area shape="rect" title=" " alt="" coords="365,5,513,47"/>
<area shape="rect" href="lock__core_8h.html" title=" " alt="" coords="376,95,503,121"/>
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="409,333,470,360"/>
<area shape="rect" href="common_2pico__time_2include_2pico_2time_8h.html" title=" " alt="" coords="307,169,401,196"/>
<area shape="rect" href="rp2__common_2hardware__sync_2include_2hardware_2sync_8h.html" title=" " alt="" coords="537,169,667,196"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="589,557,690,584"/>
<area shape="rect" title=" " alt="" coords="235,408,348,435"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="439,408,543,435"/>
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="907,408,1028,435"/>
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="116,408,211,435"/>
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="436,632,541,659"/>
<area shape="rect" title=" " alt="" coords="505,707,587,733"/>
<area shape="rect" title=" " alt="" coords="641,632,712,659"/>
<area shape="rect" title=" " alt="" coords="737,632,811,659"/>
<area shape="rect" title=" " alt="" coords="424,483,588,509"/>
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="973,483,1154,509"/>
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="1178,483,1357,509"/>
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="613,483,773,509"/>
<area shape="rect" title=" " alt="" coords="1381,483,1591,509"/>
<area shape="rect" title=" " alt="" coords="797,483,948,509"/>
<area shape="rect" title=" " alt="" coords="968,557,1159,584"/>
<area shape="rect" href="rp2__common_2hardware__timer_2include_2hardware_2timer_8h.html" title=" " alt="" coords="218,251,351,278"/>
<area shape="rect" title=" " alt="" coords="199,333,381,360"/>
<area shape="rect" title=" " alt="" coords="5,333,175,360"/>
<area shape="rect" href="address__mapped_8h.html" title=" " alt="" coords="701,251,911,278"/>
<area shape="rect" href="spin__lock_8h_source.html" title=" " alt="" coords="528,244,676,285"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="critical__section_8h__dep__incl.png" border="0" usemap="#ainclude_2pico_2critical__section_8hdep" alt=""/></div>
<map name="ainclude_2pico_2critical__section_8hdep" id="ainclude_2pico_2critical__section_8hdep">
<area shape="rect" title=" " alt="" coords="21,5,169,47"/>
<area shape="rect" href="common_2pico__sync_2include_2pico_2sync_8h.html" title=" " alt="" coords="21,95,168,121"/>
<area shape="rect" href="multicore_8h.html" title=" " alt="" coords="5,169,184,196"/>
</map>
</div>
</div>
<p><a href="critical__section_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcritical__section.html">critical_section</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a0b3d29c6f161f9975ed60d9aab8e6d3a"><td class="memItemLeft" align="right" valign="top"><a id="a0b3d29c6f161f9975ed60d9aab8e6d3a" name="a0b3d29c6f161f9975ed60d9aab8e6d3a"></a>
typedef struct __packed_aligned <a class="el" href="structcritical__section.html">critical_section</a>&#160;</td><td class="memItemRight" valign="bottom"><b>critical_section_t</b></td></tr>
<tr class="separator:a0b3d29c6f161f9975ed60d9aab8e6d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga22cd2722a96179036820e87b29209cfd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__critical__section.html#ga22cd2722a96179036820e87b29209cfd">critical_section_init</a> (critical_section_t *crit_sec)</td></tr>
<tr class="memdesc:ga22cd2722a96179036820e87b29209cfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a <a class="el" href="structcritical__section.html">critical_section</a> structure allowing the system to assign a spin lock number.  <a href="group__critical__section.html#ga22cd2722a96179036820e87b29209cfd">More...</a><br /></td></tr>
<tr class="separator:ga22cd2722a96179036820e87b29209cfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1b4eb5dcab9ac679970ac43d618de2c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__critical__section.html#gae1b4eb5dcab9ac679970ac43d618de2c">critical_section_init_with_lock_num</a> (critical_section_t *crit_sec, uint lock_num)</td></tr>
<tr class="memdesc:gae1b4eb5dcab9ac679970ac43d618de2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a <a class="el" href="structcritical__section.html">critical_section</a> structure assigning a specific spin lock number.  <a href="group__critical__section.html#gae1b4eb5dcab9ac679970ac43d618de2c">More...</a><br /></td></tr>
<tr class="separator:gae1b4eb5dcab9ac679970ac43d618de2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15e4552b4e1419faad51eba026a39aad"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__critical__section.html#ga15e4552b4e1419faad51eba026a39aad">critical_section_enter_blocking</a> (critical_section_t *crit_sec)</td></tr>
<tr class="memdesc:ga15e4552b4e1419faad51eba026a39aad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enter a <a class="el" href="structcritical__section.html">critical_section</a>.  <a href="group__critical__section.html#ga15e4552b4e1419faad51eba026a39aad">More...</a><br /></td></tr>
<tr class="separator:ga15e4552b4e1419faad51eba026a39aad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab57fcee3973b26dced4601e6018a227c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__critical__section.html#gab57fcee3973b26dced4601e6018a227c">critical_section_exit</a> (critical_section_t *crit_sec)</td></tr>
<tr class="memdesc:gab57fcee3973b26dced4601e6018a227c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release a <a class="el" href="structcritical__section.html">critical_section</a>.  <a href="group__critical__section.html#gab57fcee3973b26dced4601e6018a227c">More...</a><br /></td></tr>
<tr class="separator:gab57fcee3973b26dced4601e6018a227c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08444ba7879fae8813dd5573a13f0351"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__critical__section.html#ga08444ba7879fae8813dd5573a13f0351">critical_section_deinit</a> (critical_section_t *crit_sec)</td></tr>
<tr class="memdesc:ga08444ba7879fae8813dd5573a13f0351"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-Initialise a <a class="el" href="structcritical__section.html">critical_section</a> created by the critical_section_init method.  <a href="group__critical__section.html#ga08444ba7879fae8813dd5573a13f0351">More...</a><br /></td></tr>
<tr class="separator:ga08444ba7879fae8813dd5573a13f0351"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0be65abf0782a68a724bd6d37fd5e010"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga0be65abf0782a68a724bd6d37fd5e010">critical_section_is_initialized</a> (critical_section_t *crit_sec)</td></tr>
<tr class="memdesc:ga0be65abf0782a68a724bd6d37fd5e010"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test whether a <a class="el" href="structcritical__section.html">critical_section</a> has been initialized.  <a href="group__mutex.html#ga0be65abf0782a68a724bd6d37fd5e010">More...</a><br /></td></tr>
<tr class="separator:ga0be65abf0782a68a724bd6d37fd5e010"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>
